<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.html">engines</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html">assistants</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html">agents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.files.html">files()</a></code>
</p>
<p class="firstline">Returns the files Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Agent.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Agent.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Agent.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Agents under an Assistant which were created by the caller.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Agent</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates an Agent.

Args:
  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Performs a predefined, specific task.
  &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
    &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
  },
  &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
    &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
      &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
    },
  },
  &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
    &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
    &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
      &quot;A String&quot;,
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
  &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
  &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
  &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
  },
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
    &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
    &quot;uri&quot;: &quot;A String&quot;, # Image URI.
  },
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
  &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
  &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
    { # The starter prompt suggestion to show the user on the landing page of the agent.
      &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
  &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Performs a predefined, specific task.
  &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
    &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
  },
  &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
    &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
      &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
    },
  },
  &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
    &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
    &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
      &quot;A String&quot;,
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
  &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
  &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
  &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
  },
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
    &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
    &quot;uri&quot;: &quot;A String&quot;, # Image URI.
  },
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
  &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
  &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
    { # The starter prompt suggestion to show the user on the landing page of the agent.
      &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
  &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an Agent.

Args:
  name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets an Agent.

Args:
  name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Performs a predefined, specific task.
  &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
    &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
  },
  &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
    &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
      &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
    },
  },
  &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
    &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
    &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
      &quot;A String&quot;,
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
  &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
  &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
  &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
  },
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
    &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
    &quot;uri&quot;: &quot;A String&quot;, # Image URI.
  },
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
  &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
  &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
    { # The starter prompt suggestion to show the user on the landing page of the agent.
      &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
  &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all Agents under an Assistant which were created by the caller.

Args:
  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * &quot;update_time desc&quot; * &quot;is_pinned desc,update_time desc&quot;: list agents by is_pinned first, then by update_time.
  pageSize: integer, Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
  pageToken: string, Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the AgentService.ListAgents method.
  &quot;agents&quot;: [ # The agents visible to the caller under the parent Assistant.
    { # Performs a predefined, specific task.
      &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
        &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
      },
      &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
        &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
          &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
        },
      },
      &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
        &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
        &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
          &quot;A String&quot;,
        ],
      },
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
      &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
      &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
      &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
      &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
        &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
      },
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
      &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
        &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
        &quot;uri&quot;: &quot;A String&quot;, # Image URI.
      },
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
      &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
      &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
        { # The starter prompt suggestion to show the user on the landing page of the agent.
          &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
        },
      ],
      &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
      &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an Agent

Args:
  name: string, Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Performs a predefined, specific task.
  &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
    &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
  },
  &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
    &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
      &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
    },
  },
  &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
    &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
    &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
      &quot;A String&quot;,
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
  &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
  &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
  &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
  },
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
    &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
    &quot;uri&quot;: &quot;A String&quot;, # Image URI.
  },
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
  &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
  &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
    { # The starter prompt suggestion to show the user on the landing page of the agent.
      &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
  &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
}

  updateMask: string, Optional. The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Performs a predefined, specific task.
  &quot;a2aAgentDefinition&quot;: { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
    &quot;jsonAgentCard&quot;: &quot;A String&quot;, # Optional. The agent card is a JSON string.
  },
  &quot;adkAgentDefinition&quot;: { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
    &quot;provisionedReasoningEngine&quot;: { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent&#x27;s lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
      &quot;reasoningEngine&quot;: &quot;A String&quot;, # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
    },
  },
  &quot;authorizationConfig&quot;: { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
    &quot;agentAuthorization&quot;: &quot;A String&quot;, # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
    &quot;toolAuthorizations&quot;: [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
      &quot;A String&quot;,
    ],
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was created.
  &quot;customPlaceholderText&quot;: &quot;A String&quot;, # Optional. The custom placeholder text that appears in the text box before the user enters any text.
  &quot;deploymentFailureReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
  &quot;description&quot;: &quot;A String&quot;, # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;dialogflowAgentDefinition&quot;: { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
  },
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
  &quot;icon&quot;: { # Represents an image. # Optional. The icon that represents the agent on the UI.
    &quot;content&quot;: &quot;A String&quot;, # Base64-encoded image file contents.
    &quot;uri&quot;: &quot;A String&quot;, # Image URI.
  },
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
  &quot;rejectionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
  &quot;starterPrompts&quot;: [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
    { # The starter prompt suggestion to show the user on the landing page of the agent.
      &quot;text&quot;: &quot;A String&quot;, # Required. The text of the starter prompt.
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the agent.
  &quot;suspensionReason&quot;: &quot;A String&quot;, # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Agent was most recently updated.
}</pre>
</div>

</body></html>